package threshold

Import Path
	github.com/K-Phoen/grabana/timeseries/threshold (on go.dev)

Dependency Relation
	imports one package, and imported by one package

Involved Source Files

	    threshold.go
Package-Level Type Names (total 5)

	/* sort by: alphabet | popularity */
	 type DisplayStyle string (basic type)
		DisplayStyle represents how the threshold should be visualized.

		As Inputs Of (at least one exported)
			func Style(style DisplayStyle) Option
		As Types Of (total 4)
			const AsFilledRegions
			const AsLines
			const Both
			const Off

	 type Mode string (basic type)
		Mode represents the type of value used as threshold.

		As Inputs Of (at least one exported)
			func ValueMode(mode Mode) Option
		As Types Of (total 2)
			const Absolute
			const Percentage

	 type Option (func)
		Option represents an option that can be used to configure an axis.

		As Outputs Of (at least 4)
			func BaseColor(color string) Option
			func Steps(steps ...Step) Option
			func Style(style DisplayStyle) Option
			func ValueMode(mode Mode) Option
		As Inputs Of (at least 2)
			func New(fieldConfig *sdk.FieldConfig, options ...Option) *Threshold
			func github.com/K-Phoen/grabana/timeseries.Thresholds(options ...Option) timeseries.Option

	 type Step (struct)

		Fields (total 2)
			Color string
			Value float64
		As Inputs Of (at least one exported)
			func Steps(steps ...Step) Option

	 type Threshold (struct)
		Threshold represents a threshold visualization.

		As Outputs Of (at least one exported)
			func New(fieldConfig *sdk.FieldConfig, options ...Option) *Threshold


Package-Level Functions (total 5)

	 func BaseColor(color string) Option
		BaseColor defines the color of the thresholds' base.

	 func New(fieldConfig *sdk.FieldConfig, options ...Option) *Threshold
		New creates a new Threshold configuration.

	 func Steps(steps ...Step) Option
		Steps defines threshold steps.

	 func Style(style DisplayStyle) Option
		Style defines the thresholds display style.

	 func ValueMode(mode Mode) Option
		ValueMode defines how to interpret the threshold values.


Package-Level Constants (total 6)

	const Absolute Mode = "absolute"
	const AsFilledRegions DisplayStyle = "area"
	const AsLines DisplayStyle = "line"
	const Both DisplayStyle = "line+area"
	const Off DisplayStyle = "off"
	const Percentage Mode = "percentage"

The pages are generated with Golds v0.8.2. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.